appcompat/androidx.appcompat.widget/[main]Toolbar

Toolbar

open class Toolbar : ViewGroup, MenuHost(source)

(SESL variant) A standard toolbar for use within application content.

A Toolbar is a generalization of action bars for use within application layouts. While an action bar is traditionally part of an Activity's opaque window decor controlled by the framework, a Toolbar may be placed at any arbitrary level of nesting within a view hierarchy. An application may choose to designate a Toolbar as the action bar for an Activity using the setSupportActionBar() method.

Toolbar supports a more focused feature set than ActionBar. From start to end, a toolbar may contain a combination of the following optional elements:

A navigation button. This may be an Up arrow, navigation menu toggle, close, collapse, done or another glyph of the app's choosing. This button should always be used to access other navigational destinations within the container of the Toolbar and its signified content or otherwise leave the current context signified by the Toolbar. The navigation button is vertically aligned within the Toolbar's minimum height, if set.
A branded logo image. This may extend to the height of the bar and can be arbitrarily wide.
A title and subtitle. The title should be a signpost for the Toolbar's current position in the navigation hierarchy and the content contained there. The subtitle, if present should indicate any extended information about the current content. If an app uses a logo image it should strongly consider omitting a title and subtitle.
One or more custom views. The application may add arbitrary child views to the Toolbar. They will appear at this position within the layout. If a child view's LayoutParams indicates a Gravity value of CENTER_HORIZONTAL the view will attempt to center within the available space remaining in the Toolbar after all other elements have been measured.
An action menu. The menu of actions will pin to the end of the Toolbar offering a few frequent, important or typical actions along with an optional overflow menu for additional actions. Action buttons are vertically aligned within the Toolbar's minimum height, if set.

In modern Android UIs developers should lean more on a visually distinct color scheme for toolbars than on their application icon. The use of application icon plus title as a standard layout is discouraged on API 21 devices and newer.

buttonGravitycollapseContentDescriptioncollapseIconcontentInsetEndcontentInsetLeftcontentInsetRightcontentInsetStartcontentInsetStartWithNavigationcontentInsetEndWithActionsgravitylogologoDescriptionmaxButtonHeightnavigationContentDescriptionnavigationIconpopupThemesubtitlesubtitleTextAppearancesubtitleTextColortitletitleMargintitleMarginBottomtitleMarginEndtitleMarginStarttitleMarginToptitleTextAppearancetitleTextColormenu

Constructors

Toolbar

constructor(@NonNull context: @NonNull Context)

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet)

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet, defStyleAttr: Int)

Types

LayoutParams

open class LayoutParams : ActionBar.LayoutParams

Layout information for child views of Toolbars.

OnMenuItemClickListener

interface OnMenuItemClickListener

Interface responsible for receiving menu item click events if the items themselves do not have individual item click listeners.

SavedState

open class SavedState : AbsSavedState

Functions

addMenuProvider

@MainThread

open fun addMenuProvider(@NonNull provider: @NonNull MenuProvider)

@MainThread

open fun addMenuProvider(@NonNull provider: @NonNull MenuProvider, @NonNull owner: @NonNull LifecycleOwner)

@MainThread

open fun addMenuProvider(@NonNull provider: @NonNull MenuProvider, @NonNull owner: @NonNull LifecycleOwner, state: @NonNull Lifecycle.State)

canShowOverflowMenu

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun canShowOverflowMenu(): Boolean

collapseActionView

open fun collapseActionView()

Collapse a currently expanded action view.

dismissPopupMenus

open fun dismissPopupMenus()

Dismiss all currently showing popup menus, including overflow or submenus.

dispatchGenericMotionEvent

open fun dispatchGenericMotionEvent(event: MotionEvent): Boolean

generateLayoutParams

open fun generateLayoutParams(attrs: AttributeSet): Toolbar.LayoutParams

getCollapseContentDescription

@Nullable

open fun getCollapseContentDescription(): @Nullable CharSequence

Retrieve the currently configured content description for the collapse button view.

getCollapseIcon

@Nullable

open fun getCollapseIcon(): @Nullable Drawable

Return the current drawable used as the collapse icon.

getContentInsetEnd

open fun getContentInsetEnd(): Int

Gets the ending content inset for this toolbar.

getContentInsetEndWithActions

open fun getContentInsetEndWithActions(): Int

Gets the end content inset to use when action buttons are present.

getContentInsetLeft

open fun getContentInsetLeft(): Int

Gets the left content inset for this toolbar.

getContentInsetRight

open fun getContentInsetRight(): Int

Gets the right content inset for this toolbar.

getContentInsetStart

open fun getContentInsetStart(): Int

Gets the starting content inset for this toolbar.

getContentInsetStartWithNavigation

open fun getContentInsetStartWithNavigation(): Int

Gets the start content inset to use when a navigation button is present.

getCurrentContentInsetEnd

open fun getCurrentContentInsetEnd(): Int

Gets the content inset that will be used on the ending side of the bar in the current toolbar configuration.

getCurrentContentInsetLeft

open fun getCurrentContentInsetLeft(): Int

Gets the content inset that will be used on the left side of the bar in the current toolbar configuration.

getCurrentContentInsetRight

open fun getCurrentContentInsetRight(): Int

Gets the content inset that will be used on the right side of the bar in the current toolbar configuration.

getCurrentContentInsetStart

open fun getCurrentContentInsetStart(): Int

Gets the content inset that will be used on the starting side of the bar in the current toolbar configuration.

getLogo

open fun getLogo(): Drawable

Return the current logo drawable.

getLogoDescription

open fun getLogoDescription(): CharSequence

Return the description of the toolbar's logo.

getMenu

open fun getMenu(): Menu

Return the Menu shown in the toolbar.

getNavigationContentDescription

@Nullable

open fun getNavigationContentDescription(): @Nullable CharSequence

Retrieve the currently configured content description for the navigation button view.

getNavigationIcon

@Nullable

open fun getNavigationIcon(): @Nullable Drawable

Return the current drawable used as the navigation icon.

getOverflowIcon

@Nullable

open fun getOverflowIcon(): @Nullable Drawable

Return the current drawable used as the overflow icon.

getPopupTheme

@StyleRes

open fun getPopupTheme(): Int

getSubtitle

open fun getSubtitle(): CharSequence

Return the subtitle of this toolbar.

getSubtitleTextView

@VisibleForTesting

@Nullable

fun getSubtitleTextView(): @Nullable TextView

getTitle

open fun getTitle(): CharSequence

Returns the title of this toolbar.

getTitleMarginBottom

open fun getTitleMarginBottom(): Int

getTitleMarginEnd

open fun getTitleMarginEnd(): Int

getTitleMarginStart

open fun getTitleMarginStart(): Int

getTitleMarginTop

open fun getTitleMarginTop(): Int

getTitleTextView

@VisibleForTesting

@Nullable

fun getTitleTextView(): @Nullable TextView

getWrapper

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getWrapper(): DecorToolbar

hasExpandedActionView

open fun hasExpandedActionView(): Boolean

Check whether this Toolbar is currently hosting an expanded action view.

hideOverflowMenu

open fun hideOverflowMenu(): Boolean

Hide the overflow items from the associated menu.

inflateMenu

open fun inflateMenu(@MenuRes resId: Int)

Inflate a menu resource into this toolbar.

invalidateMenu

@MainThread

open fun invalidateMenu()

Only the items in the Menu that were provided by MenuProviders should be removed and repopulated, leaving all manually inflated menu items untouched, as they should continue to be managed manually.

isBackInvokedCallbackEnabled

open fun isBackInvokedCallbackEnabled(): Boolean

Returns whether the toolbar will attempt to register its own OnBackInvokedCallback in supported configurations to handle collapsing expanded action items when a back invocation occurs.

isOverflowMenuShowing

open fun isOverflowMenuShowing(): Boolean

Check whether the overflow menu is currently showing.

isOverflowMenuShowPending

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun isOverflowMenuShowPending(): Boolean

isTitleTruncated

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun isTitleTruncated(): Boolean

onHoverEvent

open fun onHoverEvent(ev: MotionEvent): Boolean

onRtlPropertiesChanged

open fun onRtlPropertiesChanged(layoutDirection: Int)

onTouchEvent

open fun onTouchEvent(ev: MotionEvent): Boolean

removeMenuProvider

@MainThread

open fun removeMenuProvider(@NonNull provider: @NonNull MenuProvider)

seslGetMenuView

@Nullable

open fun seslGetMenuView(): @Nullable ActionMenuView

seslGetSubtitleTextColor

open fun seslGetSubtitleTextColor(): Int

Return the color of the subtitle view.

seslGetTitleTextColor

open fun seslGetTitleTextColor(): Int

Return the color of the title view.

seslGetUserTopPadding

@Px

open fun seslGetUserTopPadding(): Int

Gets the top padding that is applied to this Toolbar.

seslSetSubtitleAlpha

open fun seslSetSubtitleAlpha(@FloatRange(from = 0.0, to = 1.0) alpha: Float)

seslSetTitleAlpha

open fun seslSetTitleAlpha(@FloatRange(from = 0.0, to = 1.0) alpha: Float)

seslSetUserTopPadding

open fun seslSetUserTopPadding(@Px topPadding: Int)

Sets a custom top padding to this Toolbar.

setBackInvokedCallbackEnabled

open fun setBackInvokedCallbackEnabled(enabled: Boolean)

Sets whether the toolbar will attempt to register its own OnBackInvokedCallback in supported configurations to handle collapsing expanded action items when a back invocation occurs.

setCollapseContentDescription